/**
 *    Copyright 2009-2021 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.io;

import org.apache.ibatis.logging.Log;
import org.apache.ibatis.logging.LogFactory;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * <p>
 * ResolverUtil用于定位类路径中可用且满足任意条件的类。两种最常见的情况是，
 * 一个类实现扩展了另一个类，或者用特定的注释注释了这个类。但是，通过使用{@link Test}类，
 * 可以使用任意条件进行搜索
 *
 * <p>类加载器用于定位类路径中包含特定包中的类的所有位置(目录和jar文件)，然后加载并检查这些类。
 * 默认情况下，使用由{@code Thread.currentThread().getContextClassloader()}返回的类加载器，
 * 但是可以在调用任何{@code find()}方法之前调用{@link #setClassLoader(ClassLoader)}}来覆盖这个类加载器
 * <p>
 * 一般搜索是通过调用{@link #find(Test, String)}并提供一个包名和一个测试实例来启动的。
 * 这将导致指定包<b>和所有子包<b>被扫描以寻找符合测试的类。还有一些实用方法用于扫描多个包以获取特定类的扩展名，
 * 或者用特定注释注释的类
 *
 * <p>ResolverUtil类的标准使用模式如下:</p>
 *
 * <pre>
 * ResolverUtil&lt;ActionBean&gt; resolver = new ResolverUtil&lt;ActionBean&gt;();
 * resolver.findImplementation(ActionBean.class, pkg1, pkg2);
 * resolver.find(new CustomTest(), pkg1);
 * resolver.find(new CustomTest(), pkg2);
 * Collection&lt;ActionBean&gt; beans = resolver.getClasses();
 * </pre>
 *
 * @param <T> the generic type
 * @author Tim Fennell
 */
public class ResolverUtil<T> {

    /**
     * 用于在此类中进行日志记录的Log实例。
     */
    private static final Log log = LogFactory.getLog(ResolverUtil.class);

    /**
     * 一个简单的接口，指定如何测试类，以确定它们是否包含在ResolverUtil生成的结果中。
     */
    public interface Test {

        /**
         * 将被候选类反复调用。如果将类包含在结果中，则必须返回True，否则返回false。
         *
         * @param type 类型
         * @return 真的, 如果成功
         */
        boolean matches(Class<?> type);
    }

    /**
     * 检查每个类是否可以分配给所提供的类的测试。注意，这个测试将匹配父类型本身，如果它被显示为匹配的话。
     */
    public static class IsA implements Test {

        /**
         * The parent.
         */
        private Class<?> parent;

        /**
         * Constructs an IsA test using the supplied Class as the parent class/interface.
         *
         * @param parentType the parent type
         */
        public IsA(Class<?> parentType) {
            this.parent = parentType;
        }

        /**
         * Returns true if type is assignable to the parent type supplied in the constructor.
         */
        @Override
        public boolean matches(Class<?> type) {
            return type != null && parent.isAssignableFrom(type);
        }

        @Override
        public String toString() {
            return "is assignable to " + parent.getSimpleName();
        }
    }

    /**
     * A Test that checks to see if each class is annotated with a specific annotation. If it
     * is, then the test returns true, otherwise false.
     */
    public static class AnnotatedWith implements Test {

        /**
         * The annotation.
         */
        private Class<? extends Annotation> annotation;

        /**
         * Constructs an AnnotatedWith test for the specified annotation type.
         *
         * @param annotation the annotation
         */
        public AnnotatedWith(Class<? extends Annotation> annotation) {
            this.annotation = annotation;
        }

        /**
         * Returns true if the type is annotated with the class provided to the constructor.
         */
        @Override
        public boolean matches(Class<?> type) {
            return type != null && type.isAnnotationPresent(annotation);
        }

        @Override
        public String toString() {
            return "annotated with @" + annotation.getSimpleName();
        }
    }

    /**
     * 正在累积的匹配集。
     */
    private final Set<Class<? extends T>> matches = new HashSet<>();

    /**
     * 查找类时使用的类加载器。如果为null，则使用Thread.currentThread().getContextClassLoader()返回的类加载器。
     */
    private ClassLoader classloader;

    /**
     * 提供对到目前为止发现的类的访问。如果没有对任何{@code find()}方法进行调用，则该集合将为空。
     *
     * @return 已发现的类的集合。
     */
    public Set<Class<? extends T>> getClasses() {
        return matches;
    }

    /**
     * 返回将用于扫描类的类加载器。如果调用方没有设置显式的类装入器，则将使用上下文类装入器。
     *
     * @return 用于扫描类的类加载器
     */
    public ClassLoader getClassLoader() {
        return classloader == null ? Thread.currentThread().getContextClassLoader() : classloader;
    }

    /**
     * 设置在扫描类时应该使用的显式类加载器。如果没有设置，则使用上下文类加载器。
     *
     * @param classloader 扫描类时使用的类加载器
     */
    public void setClassLoader(ClassLoader classloader) {
        this.classloader = classloader;
    }

    /**
     * 尝试发现可分配给所提供类型的类。在提供接口的情况下，此方法将收集实现。
     * 在非接口类的情况下，子类将被收集。累积的类可以通过调用{@link #getClasses()}来访问。
     *
     * @param parent       要查找其子类或实现的接口的类
     * @param packageNames 为类扫描一个或多个包名(包括子包)
     */
    public void findImplementations(Class<?> parent, String... packageNames) {
        if (packageNames == null) {
            return;
        }

        Test test = new IsA(parent);
        for (String pkg : packageNames) {
            find(test, pkg);
        }
    }

    /**
     * 尝试发现用该注释注释的类。累积的类可以通过调用{@link #getClasses()}来访问。
     *
     * @param annotation   应该出现在匹配类上的注释
     * @param packageNames 为类扫描一个或多个包名(包括子包)
     */
    public void findAnnotated(Class<? extends Annotation> annotation, String... packageNames) {
        if (packageNames == null) {
            return;
        }

        Test test = new AnnotatedWith(annotation);
        for (String pkg : packageNames) {
            find(test, pkg);
        }
    }

    /**
     * 扫描从提供的包开始的类，并下行到子包。
     * 每个类在发现时都提供给测试，如果测试返回true，则类被保留。
     * 累积的类可以通过调用{@link #getClasses()}来获取。
     *
     * @param test        用于过滤类的{@link Test}实例
     * @param packageName 开始扫描类的包的名称，例如{@code net.sourceforge.stripes}
     * @return the resolver util
     */
    public ResolverUtil<T> find(Test test, String packageName) {
        String path = getPackagePath(packageName);

        try {
            List<String> children = VFS.getInstance().list(path);
            for (String child : children) {
                if (child.endsWith(".class")) {
                    addIfMatching(test, child);
                }
            }
        } catch (IOException ioe) {
            log.error("Could not read package: " + packageName, ioe);
        }

        return this;
    }

    /**
     * 将Java包名转换为可以通过调用{@link ClassLoader#getResources(String)}查找的路径。
     *
     * @param packageName 要转换为路径的Java包名
     * @return 包的路径
     */
    protected String getPackagePath(String packageName) {
        return packageName == null ? null : packageName.replace('.', '/');
    }

    /**
     * Add the class designated by the fully qualified class name provided to the set of
     * resolved classes if and only if it is approved by the Test supplied.
     *
     * @param test the test used to determine if the class matches
     * @param fqn  the fully qualified name of a class
     */
    @SuppressWarnings("unchecked")
    protected void addIfMatching(Test test, String fqn) {
        try {
            String externalName = fqn.substring(0, fqn.indexOf('.')).replace('/', '.');
            ClassLoader loader = getClassLoader();
            if (log.isDebugEnabled()) {
                log.debug("Checking to see if class " + externalName + " matches criteria [" + test + "]");
            }

            Class<?> type = loader.loadClass(externalName);
            if (test.matches(type)) {
                matches.add((Class<T>) type);
            }
        } catch (Throwable t) {
            log.warn("Could not examine class '" + fqn + "'" + " due to a "
                    + t.getClass().getName() + " with message: " + t.getMessage());
        }
    }
}
